Skip to content

buffer: add Buffer.fromHex() and Buffer.fromBase64() #61157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
LiviaMedeiros wants to merge 4 commits into
base: main
Choose a base branch
from
Open

buffer: add Buffer.fromHex() and Buffer.fromBase64() #61157

LiviaMedeiros wants to merge 4 commits into from
+145 −0

Conversation

@LiviaMedeiros
Copy link
Member

@LiviaMedeiros LiviaMedeiros commented Dec 23, 2025

These methods are already present on Uint8Array, so without defining them on Buffer they return instances of Uint8Array. This introduces wrapper to return instances of Buffer instead.

Fixes: #61146

@LiviaMedeiros LiviaMedeiros added buffer Issues and PRs related to the buffer subsystem. needs-ci PRs that need a full CI run. dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. dont-land-on-v22.x PRs that should not land on the v22.x-staging branch and should not be released in v22.x. dont-land-on-v24.x PRs that should not land on the v24.x-staging branch and should not be released in v24.x. labels Dec 23, 2025
@codecov
Copy link

codecov bot commented Dec 23, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.55%. Comparing base (55600e6) to head (9c4e4c2).
⚠️ Report is 26 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main   #61157      +/-   ##
==========================================
+ Coverage   88.52%   88.55%   +0.02%     
==========================================
  Files         703      704       +1     
  Lines      208589   208810     +221     
  Branches    40226    40281      +55     
==========================================
+ Hits       184650   184908     +258     
+ Misses      15954    15926      -28     
+ Partials     7985     7976       -9
Files with missing lines Coverage Δ
lib/buffer.js 100.00% <100.00%> (ø)

... and 40 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@avivkeller
Copy link
Member

avivkeller commented Dec 24, 2025

Remember to update the docs

avivkeller
avivkeller approved these changes Dec 24, 2025
View reviewed changes
Copy link
Member

@avivkeller avivkeller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than this is missing a doc entry, LGTM

@LiviaMedeiros
Copy link
Member Author

LiviaMedeiros commented Dec 26, 2025

Agreed, added to the docs.
Initially i intentionally omitted it because these are basically inherited from Uint8Array (we don't document Buffer.prototype.at() whatsoever), but it's worth adding to indicate that these are similar-but-different from Buffer.from(string, encoding).

avivkeller
avivkeller approved these changes Dec 26, 2025
View reviewed changes
Copy link
Member

@avivkeller avivkeller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs + impl lgtm

@LiviaMedeiros LiviaMedeiros added the request-ci Add this label to start a Jenkins CI on a PR. label Dec 26, 2025
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Dec 26, 2025
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Dec 26, 2025

CI: https://ci.nodejs.org/job/node-test-pull-request/70610/

@avivkeller avivkeller added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 28, 2025
aduh95
aduh95 reviewed Dec 30, 2025
View reviewed changes
lib/buffer.js Outdated
* @returns {Buffer}
*/
Buffer.fromHex = function fromHex(str) {
// TODO(LiviaMedeiros): replace with primordial once `--js-base-64` is not optional
Copy link
Contributor

@aduh95 aduh95 Dec 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we define those only if --no-js-base-64 as it is the case today?

$ node --no-js-base-64 -p 'Buffer.fromHex'                         
undefined
$ node -p 'Buffer.fromHex'    
[Function: fromHex]

@LiviaMedeiros LiviaMedeiros removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 30, 2025
@aduh95
Copy link
Contributor

aduh95 commented Dec 30, 2025

I don't think lazy loading makes sense here, I don't see what's the upside. Why not put it under an if statement instead?

$ ./node -p '"fromHex" in Buffer'
true
$ ./node --no-js-base-64 -p '"fromHex" in Buffer'
false

@LiviaMedeiros
Copy link
Member Author

LiviaMedeiros commented Dec 31, 2025

@aduh95 IIUC buffer.js is a part of early bootstrap, which is why getOptionValue('--js-base-64') is not available yet, and Uint8Array.{fromHex,fromBase64} are still undefined even when the feature is enabled. Neither

'fromHex' in Uint8Array
Uint8Array.fromHex !== undefined
typeof Uint8Array.fromHex !== 'undefined'
const { Uint8Array: { fromHex } } = primordials
const { globalThis: { Uint8Array: { fromHex } } } = primordials
const { Uint8Array: { fromHex } } = globalThis

gives anything meaningful.
If I'm missing something and it is possible to check synchronously, please let me know, I'd be happy to replace it with if.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aduh95 aduh95 aduh95 left review comments

@avivkeller avivkeller avivkeller approved these changes

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

buffer Issues and PRs related to the buffer subsystem. dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. dont-land-on-v22.x PRs that should not land on the v22.x-staging branch and should not be released in v22.x. dont-land-on-v24.x PRs that should not land on the v24.x-staging branch and should not be released in v24.x. needs-ci PRs that need a full CI run.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Buffer.fromHex and Buffer.fromBase64 should return Buffer instances

4 participants

@LiviaMedeiros @avivkeller @nodejs-github-bot @aduh95